/*!
 * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
 * Licensed under the MIT License.
 */

const path = require("path");

/**
 * Default heading level to use when generating section headings.
 * Default = 2 based on the common use case of generating child sections under some top-level heading.
 */
const defaultSectionHeadingLevel = 2;

/**
 * Path to the directory containing the Markdown templates used in content generation.
 */
const templatesDirectoryPath = path.join(__dirname, "templates");

/**
 * Notice added to generated content output, noting that it is generated and should not be directly modified.
 */
const generatedContentNotice =
	"<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->";

/**
 * Notice added to embedded output content, noting that it is derived from other content and should not be directly modified.
 */
const embeddedContentNotice = `<!-- NOTE: This section is automatically generated by embedding the referenced file contents. Do not update these generated contents directly. -->`;

module.exports = {
	defaultSectionHeadingLevel,
	embeddedContentNotice,
	generatedContentNotice,
	templatesDirectoryPath,
};
